SGGetSettings(IM: QC)

Inside Macintosh: QuickTime Components /

Chapter 5 - Sequence Grabber Components / Sequence Grabber Components Reference

Sequence Grabber Component Functions / Working With Sequence Grabber Settings

SGGetSettings
The SGGetSettings function retrieves the current settings of all channels used by the sequence grabber. The sequence grabber places all of this configuration information into a Movie Toolbox user data list.
pascal ComponentResult SGGetSettings (SeqGrabComponent s, 
                                       UserData *ud, long flags);
s
Specifies the component instance that identifies your connection to the sequence grabber component. You obtain this value from the Component Manager's OpenDefaultComponent or OpenComponent function.
ud
Contains a pointer. The sequence grabber returns a pointer to a Movie Toolbox user data list that contains the configuration information. Your application is responsible for disposing of this user data list when you are done with it.
flags
Reserved for Apple. Set this parameter to 0.

DESCRIPTION
The SGGetSettings function allows you to retrieve the sequence grabber's configuration information. The sequence grabber, in turn, retrieves configuration information for each of its channels and stores that information in a Movie Toolbox user data list. You may subsequently use the SGSetSettings function (described in the next section) to reconfigure the sequence grabber. You can store the settings (for example, in a Preferences file) by using the Movie Toolbox's PutUserDataIntoHandle function.

RESULT CODES
Memory Manager errors

SEE ALSO
You may retrieve the configuration of one channel component by using the SGGetChannelSettings function (described on page 5-49).